Establishes a file ID reference for a file.

OSErr PBCreateFileIDRefSync (
    HParmBlkPtr paramBlock
);

paramBlock

A pointer to an fidParam variant of the HFS parameter block.

function result

A result code.

DISCUSSION

The relevant fields of the parameter block are:

• ioCompletion

  On input, a pointer to a completion function.

• ioResult

  On output, the result code of the function.

• ioNamePtr

  On input, a pointer to a filename.

• ioVRefNum

  On input, a volume specification.

• ioSrcDirID

  On input, the file’s parent directory ID.

• ioFileID

  On output, a file ID. If a file ID reference already exists for the file, PBCreateFileIDRefSync supplies the file ID but returns the result code fidExists.

Given a volume reference number, filename, and parent directory ID, the PBCreateFileIDRefSync function creates a structure to hold the name and parent directory ID of the specified file.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.

© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)